home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d19 / smlnet1d.arc / SMLNET.DOC < prev    next >
Text File  |  1988-12-25  |  23KB  |  504 lines
  1. Documentation for SMLNET.EXE  ver.1.D    A Echomail/Netmail door
  2.                               [12/25/88]
  3.  
  4.      This program was created to allow Remote callers (and Sysops)
  5.      add,edit,read, and search thru NetMail/EchoMail Conferences.
  6.  
  7.      You can:
  8.      Add Public/Private Messages into upto 99 Conferences
  9.      Search thru all messages based on numerous criteria categories
  10.      Have program look for new mail for You in all conferences
  11.      Extract messages onto a downloadable Archived file
  12.      Sysops are capable of doing File Attaches/Requests
  13.      Download via Xmodem/Ymodem/Zmodem the Archived eXtraction File
  14.      Most Important!   It keeps track of Last Message Read !!!
  15.  
  16.  
  17.      This program somewhat evolved from Bob Wescotts/Rod Bowmans
  18.      Netdoor program.  I thank them for their help, support and
  19.      understanding for the creation of 'SmlNet'.
  20.  
  21.      A Big Thank-you to Mike Davis (8:930/1) who was bold enough
  22.      to run this program on his 2node bulletin board since
  23.      Smlnet's earliest beginnings.  And for his (many) suggestions
  24.      and comments (bug finds) during Smlnet's development.
  25.  
  26.   Quick Start:
  27.       - UnPack the SmlNet Stuff into RBBS SubDirectory.
  28.         (If you put this in another subdirectory, make sure you can
  29.          have DORINFO1.DEF copied to its subdirectory.)
  30.       - Using a good Text editor modify  SMLNET.CNF to meet your
  31.         setup.  The example CNF file should display very well what
  32.         you will need to change and what the correct format is.
  33.         In this CNF file, you will instruct Smlnet the location
  34.         of 'everything'.
  35.       - To run Smlnet locally, type  SMLNET LOCAL
  36.  
  37.       - If you find bugs, please let me know.
  38.       - Have more Fun
  39.       - ESC key will return you back to the Main Menu from about everywhere
  40.  
  41.       - When you get a chance or need to, please read the remainder of
  42.         these Docs
  43.  
  44.  
  45. [[[ Limited License ]]]
  46.      This software is copyrighted but a limited license is granted and you
  47.      are free to use and share it under the following conditions:
  48.       1.  SMLNET is not distributed in modified form
  49.       2.  No fee or other consideration is charged for this program itself
  50.       3.  Reference to the copyright and author is retained.
  51.     / 4. IF YOU HAVE NOT YET REGISTERED THEN : ------------------------------
  52.     |     If your Callers Like this program, OR
  53.     |     If you want updates sent to you,   OR
  54.     |     If you need support or answers to problems
  55.     |        then please send $20 to
  56.     |                        Darwin Collins
  57.     |                       c/o  Silicon City RBBS
  58.     |                        PO BOX 532293
  59.     |                        Grand Praire, TX
  60.     |                                   75053-2293
  61.     |
  62.     |     With a donation of at least this amount:
  63.     |     One Year Subscription to:
  64.     |         You will be sent a Registered version and have access to updates
  65.     |         Program support
  66.     |         Automatic Registration to ALL my other DoorGames and Software
  67.     |         Personal Modifications will be done (if possible)
  68.     |         Access to Silicon City RBBS  (214) 641-2537 [8:930/5]
  69.     |
  70.     |     If you send a total of $30, then I will send you via Mail all
  71.     |     updates(about every 2 months) for this program and others,
  72.     |     for one year.
  73.     |
  74.     |
  75.     |   Bugs and other not-favorables in the program:
  76.     |       If you are registered($30), then you will receive the official
  77.     |       updates.  But, I will not send an official update out, whenever
  78.     |       a bug is found.(I will try to keep to 1,2, or 3 month schedule.)
  79.     |
  80.     |       When a bug is found, and fixed.  I will upload the ARCed file to
  81.     |       Silicon City, so that you can download it, if you wish to keep up
  82.     |       with the latest sub-versions.
  83.     |
  84.     |       The is a Echomail conference called  SMLWARE, that also will
  85.     |       try to support this program and others from me.
  86.     |       You may File Request the current version from 8:930/5
  87.     |
  88.     \-------------------------------------------------------------------------
  89.  
  90. [[[ Warranty ]]]
  91.  
  92.    SMLNET     is provided "AS IS" without warranty of any kind, either
  93.    expressed or implied, including, but not limited to the implied
  94.    warranties of merchantability and fitness for any purpose.  The
  95.    entire risk as to the quality and performance of this program is
  96.    with the user and should the program prove defective, the user and
  97.    not the author will assume all responsibility with correcting all
  98.    information.  The author does not warrant that this program will
  99.    function in the desired mode or will meet any users requirements
  100.    or that the operation of the program will be error free.
  101.  
  102.    But, You are certainly entitled to complain about Bugs you find in
  103.    this program and Paid Users SHOULD have a BugFree program.
  104.  
  105.    This program is written in MicroSoft QuickBasic vr. 2.01, with the
  106.    DTR patch.  This program does not need BRUN20.EXE.
  107.    The program was optimized for Size and DOES monitor the Carrier.
  108.  
  109.  If You Can Not use this Program, (ie. Don't Like it or don't run Doors )
  110.  then please make it available for others to Download.      Thank You
  111.  
  112.  
  113.  
  114.  
  115.    [  My Documentation is not very clearly written, but if you grind  ]
  116.    [  your way thru the program you may find it very very useful.     ]
  117.  
  118.  
  119. SmlNet  ( Small NetMail/EchoMail Reader )  comprises of the following files:
  120.  
  121. Files used: SMLNET.EXE    Main Program
  122.  
  123. (editible)  SMLNET.DOC    (Text)  Documentation File
  124. (editible)  SMLNET.TXT    (Text)  Doc File displayed to Remote Caller
  125. (editible)  SMLNET.CNF    (Text)  CONFIGURATION FILE!
  126. (editible)  SMLNET.DSZ    (Text)  Configuration file for DSZ setup
  127.             SMLNET.LOG    (Text)  Log File displaying usage of this program
  128.             SMLNET.1st    (Text)  This file is displayed when program is
  129.                                   first entered.
  130.             SMLNET.DAT    (Binary Data File) contains Message Pointers
  131.                                   for all active users.
  132.  
  133.             This Program will eat up approximately 250K of your Memory.
  134.  
  135.  
  136. [[[ Setup of the SmlNet.Cnf File ]]]
  137.  
  138.     The Smlnet.Cnf contains everything Smlnet.EXE needs to know
  139.     about your Net/EchoMail configuration.
  140.  
  141.     The sample SmlNet.Cnf should be a very good example of the
  142.     way that you would like to setup yours.  (So hence, just
  143.     change the necessary fields to match your system setup...)
  144.  
  145.     Information you will be inserting into this file is:
  146.  
  147.       - Sysop Name
  148.            Your Name in First LastName format.
  149.            This is name is only utilized for Local Mode.
  150.       - Advertisment line of your System
  151.            Which will appear in Netmail messages and Extract file
  152.            header.
  153.       - Net
  154.            Your Net Number
  155.       - Node
  156.            Your Node Number
  157.       - Location of NODELIST.DAT & FIDOUSER.LST
  158.            NODELIST.DAT is used for verifying Net/Node numbers when
  159.            a message is entered in the NetMail conference.
  160.            FIDOUSER.LST is used to try to find the Sysop's Name.
  161.             (this will not be successful if the file does not have
  162.              all sysops listed.)
  163.       - Location of the Binkley Outbound Area
  164.            I use this sub-directory when I create the .FLO & .REQ
  165.            files for File Attach/Requests.  When doing a File
  166.            Attach/Request, use the full Path\Filename to ensure
  167.            it finds the file.  Also, do NOT use Filename Wildcards!
  168.       - Name of Extract file
  169.            The filename of the Extract file that is used by the
  170.            remote callers when they X'tract messages into the
  171.            downloadable file.
  172.            Highly Recommended to keep to 'UNREDNET.TXT'.
  173.       - Security Access (Minimum for Sysop Access)
  174.            Any remote caller entering this program with an user
  175.            security access level equal or greater to the above
  176.            number is treated as a Sysop.
  177.            Sysop access includes:
  178.               Viewing everyone's mail (public and private).
  179.               Able to Kill any message in the Netmail conference.
  180.               Manually Delete Users from the Smlnet.dat file.
  181.       - Minimum Security level to 'Enter' or 'Reply' a message
  182.            If the remote caller is below the specified level
  183.            then he can read but not write any messages.
  184.       - Number of months before an inactive caller will be deleted
  185.            About once a day or so, the program will check for any
  186.            users that haven't been on for X number of months, and
  187.            will delete them.
  188.            (This automatic procedure will run approx. 1 out of 20
  189.             program executions.   The thinking is that the program
  190.             will be executed 20 times per day.)
  191.       - Name of Packing Program
  192.            Name of Squash program (PKPAK,ARC,SQ) that you want to
  193.            use for Squashing the Extract file before download.
  194.            (Squash program must callable in current directory.)
  195.            Type  NONE  if you don't want one.
  196.  
  197.       The program uses Zmodem(DSZ.COM) by Chuck Forsberg for
  198.       transfering the Squashed Extract file over the Modem lines.
  199.       So,  DSZ.COM  must be in the same directory or 'path'ed!
  200.  
  201.       Okay, now it is time to setup the list of conferences that you
  202.       want to access.  It is primarily the same format as what is
  203.       found in the AREAS.NET except that Descriptions are handled
  204.       upto 12 characters in length and that a special word <SYSOP>
  205.       is used to mark conferences that are only available to anyone
  206.       that has equal or greater then the above mentioned Sysop Access
  207.       Level.
  208.  
  209.       Also, there is a field called the  ID# field.  This field
  210.       instructs Smlnet which Location# that it should use for
  211.       keeping 'Last Read' Message pointers.  Valid numbers are
  212.       from 01 to 99 Only!  So when you add a conference you
  213.       must use a Unique Number(01-99) that it not currently
  214.       in-use by another conference.  This is a Unique Reference
  215.       system and the ID# should NOT be changed once it is assigned.
  216.       When you re-sort the conferences, you will NOT need to
  217.       change any of the ID# numbers.  Also, you will not change
  218.       any other conference ID# numbers when Delete a Conference.
  219.  
  220.       Because of this ID# system can be listed in any order, it is
  221.       possible for you to resort the conference names when you add
  222.       or delete conferences. (I always like sorted conference lists...)
  223.  
  224.       Note:  The first conference in the list Must be the NETMAIL
  225.              conference.
  226.  
  227.  
  228.       The basic format is:
  229.  
  230.       [ID#:]  [Drive:\Path]  [DescriptionName]  [Symbol]      per line
  231.  
  232.       ID#:             4 character field terminating with a Space character
  233.       Drive:\Path      Termainted with a Space character
  234.       DescriptionName  first 12 characters is recognized
  235.       Symbol           only <SYSOP> is used presently
  236.  
  237.       ID#                   :number from 01 to 99
  238.                             :Must be UNIQUE for each conference!
  239.                             :tell Smlnet which field for 'Last Msg' read
  240.                              so that even when the Conference names
  241.                              are added/deleted/moved the 'Last Msg' read
  242.                              pointer field location will stay with that
  243.                              conference.
  244.       Drive:\Path           :must be for a valid subdirectory
  245.                             :must have a space before and after it
  246.       DescriptionName       :first 12 characters are recognized
  247.                             :this name is displayed to the Remote user
  248.       Symbol                :if level is not met, then conference name is
  249.                              not displayed.
  250.                            <SYSOP> symbol instructs the program that this
  251.                              conference is for Sysop-Access Level users only.
  252.                            <####> symbol caller must have a security level
  253.                              equal or greater then this to join conference.
  254.                                #### means upto a 4digit security number.
  255.  
  256.       Hmm, thats it on the Smlnet.Cnf file.  Again, you should be
  257.       able to model your Config file after the one provided with
  258.       the new Smlnet files.
  259.  
  260.  
  261. [[[ RBBS-PC Environment ]]]
  262.  
  263.       If you will be running it directly from RBBS, then you need to
  264.       add  NET  to your Menu5.
  265.       NET.BAT reads:
  266.                     DEL TIMEOFF%1.DOR
  267.                     SMLNET %1
  268.  
  269.             Lines 1 and 2 of NET.bat delete the Games Monitor Transfer
  270.                files, that shouldn't exist if called directly from RBBS.
  271.                (Safety procedure).
  272.             Lines 3  calls SmlNet program
  273.  
  274.         If you will be running it under Monitor, (not recommended)
  275.         then you need to add to the  GAMES.DOR :
  276.             SmlNet---> Enter/Read/Search thru National Conferences
  277.  
  278. [[[ RunTime with RBBS-PC ]]]
  279.         To access the program Locally, type   SMLNET LOCAL
  280.         SmlNet can also recognize you are running Locally or COM0
  281.         mode if you are running RBBS-PC 15.1x or above
  282.  
  283.         If SMLNET 1, or SMLNET 2, or...   is typed then it will first
  284.         read the  DORINFO?.DEF file, which it will get its information
  285.         from.  If not found, then it will look for the first section
  286.         of MESSAGES and the RBBS?PC.DEF files.
  287.  
  288.         Comment:  If you are running this program directly from RBBS, it
  289.         is not necessary to do the  Ctrl-Break routine out of RBBS to run
  290.         SmlNet Locally, you can type  D  (for Doors) and   Net   (for
  291.         SmlNet) and then RBBS will chain to SmlNet,  SmlNet will see
  292.         you are Local and select the local mode and automatically put
  293.         your name in.
  294.  
  295.         This program will monitor Carrier, and will exit the program
  296.         whenever it sees that the Carrier has dropped.
  297.         Currently, it can support COM1 and COM2 only.
  298.         (this can be expanded when necessary info is available.)
  299.  
  300. [[[ RunTime with PCBOARD  ]]]
  301.        Will autoconfig between PCBoard verison 12 and 14  .sys formats.
  302.  
  303.        -------------------------------------------------------------
  304.        For usage on multiple nodes requires Version 14 .SYS file.
  305.        -------------------------------------------------------------
  306.  
  307.        Command Line Parameters:
  308.        =============================================================
  309.        For:  Disable User Security Level or using version 12 .SYS
  310.  
  311.        SMLNET PATH\PCBOARD.SYS 1
  312.               |                |
  313.               ^sysfile         ^COMport
  314.        -------------------------------------------------------------
  315.        For:  Activate User Security Levels requires Version 14 .SYS
  316.  
  317.        SMLNET PATH\PCBOARD.SYS 1 PATH\USERS
  318.               |                | |
  319.               ^sysfile  COMport^ ^Usersfile
  320.        =============================================================
  321.        Which is:
  322.              PATH\PCBOARD.SYS    - Path and filename of PCBoard.sys file
  323.              PATH\USERS          - Path and filename of PCBoard Users file
  324.              1   (or 2)          - Com.Port
  325.  
  326.  
  327.         Thank Vernan's War Board at (714) 989-7596 for uploading
  328.         info on how to get DoorGames to work with PCBOARD.
  329.         To setup Smlnet, so that it will run with PCBOARD, you will need
  330.         setup a Door Bat file that will then call SMLNET.EXE in this
  331.         fashion.      SMLNET \PATH\PCBOARD.SYS 1
  332.            \PATH\PCBOARD.SYS  is the path and the name of the .SYS file
  333.               that you want smlnet, to read to get the Player's Info like
  334.               their Names, and the time available.
  335.            1 (can be 2) is the ComPort number, for the program to use
  336.               the correct ComPort for Remote Operations.
  337.            This format must be always used, even if for remote or local
  338.               use with PCBOARD.   You can run in Local mode in 2 ways,
  339.               either telling PCBOARD you are local, so that it will put
  340.               Local into the pcboard.sys file, or you can type Smlnet LOCAL.
  341.            \Path\Users   is the path and the name of the PCboard Users file.
  342.               Smlnet will ONLY read the security level from this file.
  343.               If you do not want security levels or can create a Version
  344.               14 Users file, then leave the \Path\Users section blank.
  345.  
  346.         Current version should work automatically between PCBoard 12.x and
  347.            PC Board 14+ .  You must have at least PC Board 14 to run it
  348.            under multiple nodes.
  349.  
  350. [[[ Function Keys Supported: ]]]   Currently only  F10 is supported.
  351.  
  352.      Chat Mode   F10
  353.  
  354.         F10 will interrupt the  Command ->  prompt and will enter
  355.         a routine for Chat Mode.
  356.         If you press the F10 key when Chat is already engaged it will
  357.         Beep both you and the remote user.
  358.         Though, You may also send Beeps (ASCII 7) to each other.
  359.  
  360.         Either the remote user or the sysop can send the ESC code
  361.         and Chat will then be terminated.
  362.         The Timeout default of 4 minutes is not monitored in Chat
  363.         Mode, but Loss of Carrier is.
  364.  
  365.  
  366. [[[  Sysop Setup for Remote Caller Message Extraction  ]]]
  367.  
  368.         Messages can be packed by a file squasher like PKPak
  369.         by PkWare, Inc.  Personally, I like PkPak & PkUnPak,
  370.         but you may use others as you wish.
  371.  
  372.         Messages selected by the user are appended into a
  373.         sequential 'EXTRACT' file.  This file is downloaded
  374.         by Shelling to DSZ.COM  (by Chuck Forzberg) so,
  375.         Xmodem, Ymodem(1K Packet), and Zmodem is supported.
  376.         If you haven't ever tried DSZ.COM, then please treat
  377.         yourself to this excellent Communication program.
  378.         Zmodem is excellant over the long distance lines!
  379.  
  380.         Basically, you will just need to move DSZ.COM into
  381.         the same sub-directory has Smlnet.exe occupies.
  382.         I encourage you to register DSZ.COM for it is the
  383.         best file transfer program so far as I have seen
  384.         in ShareWare.
  385.  
  386.         The default Extract file is  UNREDNET.TXT
  387.         The default Packed  file is  UNREDNET.ARC
  388.         The Extract,Archive, and Log filenames depend on the Node#.
  389.         (The first character to the left of the '.' will reflect
  390.          the node # that the caller is on.)
  391.         For example:
  392.             Local Mode         UNREDNET.TXT ,UNREDNET.ARC, SMLNETT.LOG
  393.             Node 0  will have  UNREDNE0.TXT ,UNREDNE0.ARC, SMLNET0.LOG
  394.             Node 1  will have  UNREDNE1.TXT ,UNREDNE1.ARC, SMLNET1.LOG
  395.             Node 2  will have  UNREDNE2.TXT ,UNREDNE1.ARC, SMLNET2.LOG
  396.  
  397.         It is not recommended but via the SMLNET.CNF file you can
  398.         change the drive:\path of the extract file.  The program
  399.         will use the 'extract' filename that you specify
  400.         but it will always display  'UNREDNET.TXT', and use the
  401.         'UNREDNET.ARC' for the packing routines.  Again, for example
  402.         for Node #2, the remote caller will see 'UNREDNET.TXT'
  403.         and/or 'UNREDNET.ARC' but internally the program will use
  404.         the filename that is in the SMLNET.CNF file with
  405.         the Node 2 to the left side of the '.' mark.
  406.         The 'Extract' file specified in the SMLNET.CNF must have an
  407.         extension such as '.TXT' or '.LST'.
  408.         Probably the best method is to leave the program default to
  409.         the UNREDNET.TXT filename in the SMLNET.CNF file.
  410.  
  411.         Smlnet will not allow a remote user to create an 'extract'
  412.         file that is bigger then the time needed to download the
  413.         file.  BUT, it will allow the remote user to download the
  414.         'extract' file no matter how much time he has left.
  415.  
  416.         The 'Extract' file is Always re-initialized upon startup
  417.         of Smlnet program.
  418.  
  419.  
  420. [[[ Limitations of the Program ]]]
  421.  
  422.       This program may have some problems with very large sized
  423.       messages.  Whenever, an individual message may be greater
  424.       then 20K in size, then the program may error out and exit.
  425.  
  426.       This program code logic has been changed so that it is
  427.       optimized for Size. (so hence the programming structure
  428.       is now poor, and does not follow good programming logic).
  429.  
  430.    (Items that can be changed if needed)
  431.         A maximum of 9999 Messages in a Base can be accessed.
  432.         A maximum of   99 Conferences can be accessed.
  433.         A maximum of  300 lines for each message for Extracting/Saving.
  434.  
  435.    (Current Version)
  436.       This program does not do any type of File or Record Locking,
  437.           so if you must take proper precautions if operating in
  438.           a Multi-Tasking / Multi-User environment.
  439.           Could someone send me some Good DOCS on how to do
  440.           record/file locking ?
  441.       BUT, it does a good job on trying to make sure nothing will get
  442.            scrambled when working with a Multi-Node system.  And
  443.            especially for the Fido-type of message formats
  444.             (one message per filename, the odds are real low.)
  445.  
  446.             ...FILE SHARING is in, but not full File locking.
  447.  
  448.  
  449. [[[ Revisions to the Program ]]]
  450.  
  451.    Version 1.0D: mini versions
  452.  
  453.    Version 1.0:  October 15, 1988
  454.                  The very first version of this program.
  455.  
  456.                  Since this is the very first version of this
  457.                  utility, it probably has some bugs in it.
  458.  
  459.  
  460.  
  461.         Have fun with the program, it includes about every possible
  462.         (usefull) command that could be done with the EchoMail
  463.         conferences.  If you need more, just let me know.
  464.  
  465.  
  466.  
  467. ══ END OF SMLNET DOCUMENTATION ═════════════════════════════════════════════
  468.  
  469.  
  470.  
  471.  
  472. ------ Okay, now commercial time !!! for any Unregistered ones --------------
  473.  
  474. The 1988 software concept so far involves...   (As of 12/01/88)
  475.  
  476.  
  477. 2.   SIDROIDS   (Command BattleDroids in a 30,000 cell field, with the
  478.                  use of Messages, Teams, and Scripts that will control
  479.                  your Droid during anothers play period)
  480.                 (Current ShareWare version 2.36.
  481.                 (Registered version also has some more stuff..(2.5x)
  482.                 (PCboard/ RBBS compatible)
  483.  
  484. 3.    THAI      The UnderGround Thai Lottery - A Lottery Simulation DoorGame
  485.                 (Play the Thailand Lottery...)  Current Version 1.3
  486.                 (A minor program but kinda educational...)
  487.                 (PCboard/ RBBS compatible)
  488.  
  489. 4.   SMLNET     Small Netmail/EchoMail Editor/Reader (does alot of neat stuff)
  490.                 download message files, keep message pointers, and more!
  491.                 (PCboard/RBBS compatible)
  492.  
  493. 5.   SMLMESS    Small Message Utility is created for RBBS sysops
  494.                 download message files, keep message pointers, and more!
  495.                 (Egads, another Message Editor?)
  496.  
  497. 6.   SMLCALL    Small Caller Analyzer  - is utility created for RBBS sysops
  498.                 wanting to do simple but effective analyzing on their
  499.                 Callers and System. Remote and Batch Support.
  500.                 Current version 2.2
  501.  
  502.  
  503. and more whenever I get a good chance to work on...
  504.